/* Siconos is a program dedicated to modeling, simulation and control
 * of non smooth dynamical systems.
 *
 * Copyright 2024 INRIA.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef gfc3d_compute_error_H
#define gfc3d_compute_error_H
#include "NumericsFwd.h"    // for GlobalFrictionContactProblem, SolverOptions
#include "SiconosConfig.h"  // for BUILD_AS_CPP // IWYU pragma: keep

/*!\file gfc3d_compute_error.h
  \brief functions related to error computation for friction-contact problems
*/

#if defined(__cplusplus) && !defined(BUILD_AS_CPP)
extern "C" {
#endif

/** Error computation for global friction-contact 3D problem
 *
 *  The computation of the error uses as input the reaction (reaction) and the global velocity
 * (globalVelocity) The value of the local velocity (velocity) is recomputed
 *
 *  \param problem the structure which defines the friction-contact problem
 *  \param[in] reaction
 *  \param[in] velocity
 *  \param[out] globalVelocity
 *  \param tolerance value for error computation
 *  \param options pointer to SolverOptions
 *  \param norm_q norm of q or a normalization value
 *  \param norm_b norm of b or a normalization value
 *  \param[in,out] error value
 *  \return 0 if successfull
 */
int gfc3d_compute_error(GlobalFrictionContactProblem* problem, double* reaction,
                        double* velocity, double* globalVelocity, double tolerance,
                        SolverOptions* options, double norm_q, double norm_b, double* error);
int gfc3d_compute_error_convex(GlobalFrictionContactProblem* problem, double* reaction,
                               double* velocity, double* globalVelocity, double tolerance,
                               SolverOptions* options, double norm_q, double norm_b,
                               double* error);

#if defined(__cplusplus) && !defined(BUILD_AS_CPP)
}
#endif

#endif
